home *** CD-ROM | disk | FTP | other *** search
/ Merciful 1 / Merciful - Disc 1.iso / software / a / asm_one / asm-onev1.25a.dms / in.adf / Release3.1 / AutoDocs3.1.lha / doc / picture_dtc.doc < prev    next >
Encoding:
Text File  |  1993-08-12  |  3.9 KB  |  155 lines
  1. TABLE OF CONTENTS
  2.  
  3. picture.datatype/picture.datatype
  4. picture.datatype/picture.datatype           picture.datatype/picture.datatype
  5.  
  6.     NAME
  7.     picture.datatype -- root data type for pictures.
  8.  
  9.     FUNCTION
  10.     The picture.datatype is the super-class for any picture related
  11.     classes.
  12.  
  13.     METHODS
  14.     OM_NEW -- Create a new picture object.
  15.  
  16.     OM_GET -- Obtain the value of an attribute.
  17.  
  18.     OM_SET -- Set the values of multiple attributes.
  19.  
  20.     OM_UPDATE -- Update the values of multiple attributes.
  21.  
  22.     OM_DISPOSE -- Dispose of a picture object.
  23.  
  24.     GM_LAYOUT -- Layout the object and notify the application of the
  25.         title and size.
  26.  
  27.     GM_HITTEST -- Determine if the object has been hit with the
  28.         mouse.
  29.  
  30.     GM_GOACTIVE -- Tell the object to go active.
  31.  
  32.     GM_HANDLEINPUT -- Handle input.
  33.  
  34.     GM_RENDER -- Cause the graphic to render.
  35.  
  36.     DTM_PROCLAYOUT -- Layout (remap) the picture on the application's
  37.         process.
  38.  
  39.     DTM_FRAMEBOX -- Obtain the display environment that the picture
  40.         requires.
  41.  
  42.     DTM_SELECT -- Select an area in the picture.
  43.  
  44.     DTM_CLEARSELECTED -- Deselect the selected area of the picture.
  45.  
  46.     DTM_COPY -- Copy the selected area of the picture to the clipboard
  47.         as an ILBM.  If no area is selected, then the entire picture
  48.         is copied.
  49.  
  50.     DTM_PRINT -- Print the selected area of the picture.  If no area
  51.         is selected, then the entire picture is printed.
  52.  
  53.     DTM_WRITE -- Write the selected area of the picture to a file as an
  54.         ILBM.  If no area is selected, then the entire picture is
  55.         saved.
  56.  
  57.     TAGS
  58.     OBP_Precison (ULONG) -- Precision to use when obtaining colors.
  59.         See the PRECISION_ defines in <graphics/view.h>.
  60.  
  61.         Applicability is (I).
  62.  
  63.     PDTA_ModeID (ULONG) -- Set and get the graphic mode id of the
  64.         picture.
  65.  
  66.         Applicability is (ISG).
  67.  
  68.     PDTA_BitMapHeader (struct BitMapHeader *) -- Set and get the
  69.         base information for the picture.  BitMapHeader is defined in
  70.         <datatypes/pictureclass.h>
  71.  
  72.         Applicability is (G).
  73.  
  74.     PDTA_BitMap (struct BitMap *) -- Pointer to a class-allocated
  75.         bitmap, that will end up being freed by the picture class in the
  76.         OM_DISPOSE method.
  77.  
  78.         Applicability is (ISG).
  79.  
  80.     PDTA_ColorRegisters (struct ColorRegister *) -- Color table.
  81.  
  82.         Applicability is (G).
  83.  
  84.     PDTA_CRegs (ULONG *) -- Color table to use with SetRGB32CM().
  85.  
  86.         Applicability is (G).
  87.  
  88.     PDTA_GRegs (ULONG *) -- Color table.
  89.  
  90.         Applicability is (G).
  91.  
  92.     PDTA_ColorTable (ULONG *) -- Shared pen table.
  93.  
  94.         Applicability is (G).
  95.  
  96.     PDTA_ColorTable2 (ULONG *) -- Shared pen table.
  97.  
  98.         Applicability is (G).
  99.  
  100.     PDTA_Allocated (ULONG) --  Number of shared colors allocated.
  101.  
  102.         Applicability is (G).
  103.  
  104.     PDTA_NumColors (WORD) -- Number of colors used by the picture.
  105.  
  106.         Applicability is (ISG).
  107.  
  108.     PDTA_NumAlloc (WORD) -- Number of colors allocated by the picture.
  109.  
  110.         Applicability is (G).
  111.  
  112.     PDTA_Remap (BOOL) -- Indicate whether the picture should be
  113.         remapped or not.
  114.  
  115.         Applicability is (I).
  116.  
  117.     PDTA_Screen (struct Screen *) -- Pointer to the screen to remap
  118.         the picture to.  Only used if the object is not going to be
  119.         added to a window.
  120.  
  121.         Applicability is (IS).
  122.  
  123.     PDTA_FreeSourceBitMap (BOOL) -- Indicate whether the source
  124.         bitmap should be freed immediately by the picture.datatype
  125.         after the GM_LAYOUT method is called.
  126.  
  127.         Applicability is (IS).
  128.  
  129.     PDTA_Grab (Point *) -- Pointer to a Point structure, that
  130.         defines the grab point of the picture.
  131.  
  132.         Applicability is (ISG).
  133.  
  134.     PDTA_DestBitMap (struct BitMap *) -- Pointer to the remapped
  135.         bitmap.
  136.  
  137.         Applicability is (G).
  138.  
  139.     PDTA_ClassBitMap (struct BitMap *) --
  140.  
  141.         Applicability is (ISG).
  142.  
  143.     PDTA_NumSparse (UWORD) -- Number of entries in the sparse color
  144.         table.
  145.  
  146.         Applicability is (I).
  147.  
  148.     PDTA_SparseTable (UBYTE *) -- Pointer to a table of pen numbers
  149.         indicating which colors should be used when remapping the
  150.         picture.  This array must contain as many entries as indicated
  151.         by the PDTA_NumSparse tag.
  152.  
  153.         Applicability is (I).
  154.  
  155.